﻿#region Copyright
// Copyright (c) 2011-2012 RaisingForce Team (Alikin Sergey)
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using System;
using System.Diagnostics.Contracts;
using System.Runtime.Serialization;

namespace RaisingForce.Raise.Hardware
{
    /// <summary>
    /// Представляет исключение, происходящее при обращении к оборудованию робота
    /// в случае возникновения непредвиденной ситуации.
    /// </summary>
    /// <seealso cref="RobotHardwareFailureReason"/>
    /// <seealso cref="IRobotHardware"/>
    /// <seealso cref="IRobotEngine"/>
    /// <seealso cref="IRobotSensor"/>
    [Serializable]
    sealed public class RobotHardwareException :
        ApplicationException
    {
        #region Constructors

        /// <summary>
        /// Инициализирует экземпляр класса <c>RobotHardwareException</c>
        /// с указанием причины произошедшей ошибки
        /// и текстового сообщения, описывающего эту ошибку.
        /// </summary>
        /// <param name="failureReason">Причина произошедшей ошибки.</param>
        /// <param name="message">Сообщение об ошибке с объяснением причины исключения.
        /// Не может быть задано как null.</param>
        /// <seealso cref="RobotHardwareFailureReason"/>
        public RobotHardwareException(
            RobotHardwareFailureReason failureReason,
            string message)
            : base(message)
        {
            Contract.Requires(message != null);
            this.FailureReason = failureReason;
        }

        /// <summary>
        /// Инициализирует экземпляр класса <c>RobotHardwareException</c>
        /// с указанием причины произошедшей ошибки,
        /// текстового сообщения, описывающего эту ошибку,
        /// и внутреннего исключения, являющегося причиной текущего исключения.
        /// </summary>
        /// <param name="failureReason">Причина произошедшей ошибки.</param>
        /// <param name="message">Сообщение об ошибке с объяснением причины исключения.
        /// Не может быть задано как null.</param>
        /// <param name="innerException">Исключение, являющееся причиной текущего исключения.
        /// Если параметр innerException не является указателем NULL,
        /// текущее исключение вызывается в блоке catch,
        /// обрабатывающем внутренние исключения.</param>
        /// <seealso cref="RobotHardwareFailureReason"/>
        public RobotHardwareException(
            RobotHardwareFailureReason failureReason,
            string message,
            Exception innerException)
            : base(message, innerException)
        {
            Contract.Requires(message != null);
            this.FailureReason = failureReason;
        }

        private RobotHardwareException(
            SerializationInfo info,
            StreamingContext context)
            : base(info, context)
        {
            Contract.Requires(info != null);
        }

        #endregion

        #region Properties

        private const string failureReasonKey = "FailureReason";

        /// <summary>
        /// Получает причину произошедшей ошибки.
        /// </summary>
        /// <value>Причина произошедшей ошибки.</value>
        /// <seealso cref="RobotHardwareFailureReason"/>
        public RobotHardwareFailureReason FailureReason
        {
            get
            {
                return (RobotHardwareFailureReason)
                    this.Data[RobotHardwareException.failureReasonKey];
            }
            private set
            {
                this.Data[RobotHardwareException.failureReasonKey] = value;
            }
        }

        #endregion
    }
}
